home *** CD-ROM | disk | FTP | other *** search
/ Space & Astronomy / Space and Astronomy (October 1993).iso / pc / viewers / mac / jpeg2gif / ppmquant_folder / readme next >
Text File  |  1991-11-08  |  15KB  |  341 lines
  1.                   Extended Portable Bitmap Toolkit
  2.                       Distribution of 27sep91
  3.                    Previous distribution 05feb91
  4.  
  5.  
  6. PBMPLUS is a toolkit for converting various image formats to and from
  7. portable formats, and therefore to and from each other.  The idea is,
  8. if you want to convert among N image formats, you only need 2*N
  9. conversion filters, instead of the N^2 you would need if you wrote each
  10. one separately.
  11.  
  12. In addition to the converters, the package includes some simple tools
  13. for manipulating the portable formats.
  14.  
  15. The package is broken up into four parts.  First is PBM, for bitmaps (1
  16. bit per pixel).  Then there is PGM, for grayscale images.  Next is PPM,
  17. for full-color images.  Last, there is PNM, which does content-independent
  18. manipulations on any of the three internal formats, and also handles
  19. external formats that have multiple types.
  20.  
  21. The parts are upwards compatible: PGM reads both PGM and PBM files and
  22. writes PGM; PPM reads all three and writes PPM; and PNM reads all three
  23. and writes, usually, the same type as it read.  Whenever PNM makes an
  24. exception and "promotes" a file to a higher format, it lets you know.
  25.  
  26.  
  27. INSTALLATION
  28.  
  29.     Unpack the files.
  30.     Decide whether you want to use Imakefiles or Makefiles.  If you want
  31.       to use Makefiles:
  32.  
  33.     Edit the top-level Makefile, find each line with the string
  34.       "CONFIGURE", and follow the directions for setting configuration
  35.       options.
  36.     Likewise edit pbmplus.h.
  37.     If you are using gnu make, you have to edit *all* the Makefiles
  38.       and remove all the imake stuff at the ends, otherwise gnu make
  39.       will overwrite the Makefiles.
  40.     Make.
  41.     When you're happy that things compiled ok, make install.
  42.     
  43.     The Imakefiles are pretty minimal, but if you want to use them anyway:
  44.  
  45.     Edit pbmplus.h, find each line with the string "CONFIGURE", and
  46.       follow the directions for setting configuration options.
  47.     Save the original Makefiles, in case you later want to switch back
  48.       to using them.
  49.     The usual X11 sequence of xmkmf, make Makefiles, make depend, then
  50.       make should work.
  51.     When you're happy that things compiled ok, make install and
  52.       make install.man.
  53.  
  54. After installing the manual pages, you may want to create the "whatis"
  55. file by doing a catman -w -M <directory>, or whatever the equivalent is
  56. on your system.
  57.  
  58.  
  59. SUPPORT
  60.  
  61. I've tested this stuff under SysV and BSD, on Sun 3's 4's and 386's and
  62. Sequents and Vaxen and HPs, with cc and gcc.  Nevertheless, I'm sure bugs
  63. remain, and portability to systems like Amigas and IBM compatibles is
  64. an interesting question.  Feedback is welcome; send bug reports,
  65. enhancements, etc. to this address:
  66.  
  67.     jef@well.sf.ca.us
  68.     {apple, ucbvax}!well!jef
  69.  
  70. When sending bug reports, always include the output from running any
  71. PBMPLUS program with the -version flag.  Also include the type of
  72. system you are on, what compiler you used, and whether you are using
  73. Makefiles or Imakefiles.  I try to respond to bug reports and enhancements
  74. promptly; say, within a week.
  75.  
  76. Also, if there is a new format or feature you would like to have added
  77. to the package, feel free to drop me a line.  If it's a format, include
  78. whatever documentation you have, and if possible a uuencoded sample.
  79. My response time will depend on how busy I am, and how easy the job
  80. looks.  If you need it right away, or it's a complicated job, you might
  81. consider paying me; lately, that's how a lot of work on the package has
  82. gotten done.
  83.  
  84. Finally, if you have access to Usenet, there's a newsgroup called
  85. alt.graphics.pixutils which is specifically for discussion of image
  86. conversion and editing packages such as PBMPLUS.  Posting stuff there
  87. is even better than mailing it to me, since it lets other people help
  88. out with the answers.
  89.  
  90.  
  91. HOW TO FIND THE RIGHT CONVERTER
  92.  
  93. Some people get confused by all the different names.  If you want to
  94. convert a pbm file to a Sun raster file, is it pbmtorast, pgmtorast,
  95. ppmtorast, or pnmtorast?  In this case some of the confusion might be
  96. because previous versions of the package did in fact have both
  97. pbmtorast and ppmtorast.  But mostly it's just too many different
  98. things to hold in your short term memory.  Fine, so don't even try to
  99. remember what's what.  That's what computers are for.  Unix, at least
  100. BSD Unix, has this great indexing feature on the "man" program.  You
  101. say "man -k <keyword>" and it gives you all the one-line descriptions
  102. with that keyword in them.  All the PBMPLUS man pages have nice useful
  103. one-line descriptions, that mention all the relevant keywords.  Try it,
  104. you'll like it.
  105.  
  106.  
  107. COPYRIGHTS
  108.  
  109. All the software in this package, whether by me or by a contributer,
  110. has a copyright similar to this one:
  111.  
  112.     Permission to use, copy, modify, and distribute this software and its
  113.     documentation for any purpose and without fee is hereby granted, provided
  114.     that the above copyright notice appear in all copies and that both that
  115.     copyright notice and this permission notice appear in supporting
  116.     documentation.  This software is provided "as is" without express or
  117.     implied warranty.
  118.  
  119. Many people get confused by this legalese, especially the part about
  120. "without fee".  Does this mean you can't charge for any product that
  121. uses PBMPLUS?  No.  All it means is that you don't have to pay me.
  122. You can do what you want with this software.  Build it into your
  123. package, steal code from it, whatever.  Just be sure to let people
  124. know where it came from.
  125.  
  126.  
  127. CONTENTS
  128.  
  129. Files in pbmplus.shar:
  130.  
  131.     README        this
  132.     CHANGES        list of changes between the various versions of PBM
  133.     TODO        list of things still to be done
  134.     FORMATS        list of the formats supported
  135.     OTHER.SYSTEMS    list of other free image-processing software
  136.     Makefile        guess
  137.     Imakefile        for X11-type installations
  138.     pbmplus.h        header file for PBM, PGM, PPM, and PNM
  139.  
  140.     compat.csh        csh script for compatibility with old versions
  141.     compat.ksh        ksh script for compatibility with old versions
  142.     magic        additions for /etc/magic to recognize some image formats
  143.  
  144. Files in pbm.shar?:
  145.  
  146.     Makefile        guess
  147.     Imakefile        for X11-type installations
  148.  
  149.     atktopbm.c        convert Andrew Toolkit raster object to portable bitmap
  150.     brushtopbm.c    convert Xerox doodle brushes to portable bitmap
  151.     cmuwmtopbm.c    convert CMU window manager format to portable bitmap
  152.     g3topbm.c        convert Group 3 FAX to portable bitmap
  153.     icontopbm.c        convert Sun icon to portable bitmap
  154.     gemtopbm.c        convert GEM .img format to portable bitmap
  155.     macptopbm.c        convert MacPaint to portable bitmap
  156.     mgrtopbm.c        convert MGR format to portable bitmap
  157.     pi3topbm.c        convert Atari Degas .pi3 to portable bitmap
  158.     xbmtopbm.c        convert X10 or X11 bitmap to portable bitmap
  159.     ybmtopbm.c        convert Bennet Yee "face" file into portable bitmap
  160.  
  161.     pbmto10x.c        convert portable bitmap to Gemini 10x printer graphics
  162.     pbmtoascii.c    convert portable bitmap to ASCII graphic form
  163.     pbmtoatk.c        convert portable bitmap to Andrew Toolkit raster object
  164.     pbmtobbnbg.c    convert portable bitmap to BBN BitGraph graphics
  165.     pbmtocmuwm.c    convert portable bitmap to CMU window manager format
  166.     pbmtoepson.c    convert portable bitmap to Epson printer graphics
  167.     pbmtog3.c        convert portable bitmap to Group 3 FAX
  168.     pbmtogem.c        convert portable bitmap into GEM .img file
  169.     pbmtogo.c        convert portable bitmap to GraphOn graphics
  170.     pbmtoicon.c        convert portable bitmap to Sun icon
  171.     pbmtolj.c        convert portable bitmap to HP LaserJet graphics
  172.     pbmtomacp.c        convert portable bitmap to MacPaint
  173.     pbmtomgr.c        convert portable bitmap to MGR format
  174.     pbmtopi3.c        convert portable bitmap to Atari Degas .pi3
  175.     pbmtoplot.c        convert portable bitmap into Unix plot(5) file
  176.     pbmtoptx.c        convert portable bitmap to Printronix graphics
  177.     pbmtoxbm.c        convert portable bitmap to X11 bitmap
  178.     pbmtox10bm.c    convert portable bitmap to X10 bitmap
  179.     pbmtoybm.c        convert portable bitmap into Bennet Yee "face" file
  180.     pbmtozinc.c        convert portable bitmap to Zinc Interface Library icon
  181.  
  182.     pbmlife.c        apply Conway's rules of Life to a portable bitmap
  183.     pbmmake.c        create a blank bitmap of a specified size
  184.     pbmmask.c        create a mask bitmap from a regular bitmap
  185.     pbmreduce.c        reduce a portable bitmap N times, using Floyd-Steinberg
  186.     pbmtext.c        render text into a bitmap
  187.     pbmupc.c        create a Universal Product Code bitmap
  188.  
  189.     libpbm[1-5].c    a few utility routines
  190.     pbmmerge.c        merge wrapper routine
  191.     pbm.h        header file for libpbm
  192.     pbmfont.h        header file for font routines in libpbm
  193.     libpbm.h        internal header file for libpbm
  194.     g3.h        definitions for Group 3 FAX
  195.     macp.h        definitions for MacPaint files
  196.     bitreverse.h    useful include file
  197.     *.1            manual entries for all of the tools
  198.     pbm.5        manual entry for the pbm format
  199.     libpbm.3        manual entry for the pbm library
  200.  
  201. Files in pgm.shar?:
  202.  
  203.     Makefile        guess
  204.     Imakefile        for X11-type installations
  205.  
  206.     fitstopgm.c        convert FITS format to portable graymap
  207.     fstopgm.c        convert Usenix FaceSaver(tm) format to portable graymap
  208.     hipstopgm.c        convert HIPS format to portable graymap
  209.     lispmtopgm.c    convert a Lisp Machine bitmap file into pgm format
  210.     psidtopgm.c        convert PostScript "image" data to portable graymap
  211.     rawtopgm.c        convert raw grayscale bytes to portable graymap
  212.  
  213.     pgmtofits.c        convert portable graymap to FITS format
  214.     pgmtofs.c        convert portable graymap to Usenix FaceSaver(tm) format
  215.     pgmtolispm.c    convert a portable graymap into Lisp Machine format
  216.     pgmtopbm.c        convert portable graymap to portable bitmap
  217.  
  218.     pgmbentley.c    Bentleyize a portable graymap
  219.     pgmedge.c        edge-detect a portable graymap
  220.     pgmenhance.c    edge-enhance a portable graymap
  221.     pgmhist.c        print a histogram of the values in a portable graymap
  222.     pgmnorm.c        normalize contrast in a portable graymap
  223.     pgmoil.c        turn a portable graymap into an oil painting
  224.     pgmramp.c        generate a grayscale ramp
  225.     pgmtexture.c    calculate textural features on a portable graymap
  226.  
  227.     libpgm[1-3].c    a few utility routines
  228.     pgmmerge.c        merge wrapper routine
  229.     pgm.h        header file for libpgm
  230.     libpgm.h        internal header file for libpgm
  231.     dithers.h        useful include file
  232.     *.1            manual entries for all of the tools
  233.     pgm.5        manual entry for the pgm format
  234.     libpgm.3        manual entry for the pgm library
  235.  
  236. Files in ppm.shar?:
  237.  
  238.     Makefile        guess
  239.     Imakefile        for X11-type installations
  240.  
  241.     giftoppm.c        convert GIF to portable pixmap
  242.     gouldtoppm.c    convert Gould scanner file to portable pixmap
  243.     ilbmtoppm.c        convert IFF ILBM to portable pixmap
  244.     imgtoppm.c        convert Img-whatnot to portable pixmap
  245.     mtvtoppm.c        convert MTV ray-tracer output to portable pixmap
  246.     pcxtoppm.c        convert PC Paintbrush format to portable pixmap
  247.     pgmtoppm.c        colorize a portable graymap into a portable pixmap
  248.     pi1toppm.c        convert Atari Degas .pi1 to portable pixmap
  249.     picttoppm.c        convert Macintosh PICT to portable pixmap
  250.     pjtoppm.c        convert HP PaintJet file to portable pixmap
  251.     qrttoppm.c        convert QRT ray-tracer output to portable pixmap
  252.     rawtoppm.c        convert raw RGB bytes to portable pixmap
  253.     rgb3toppm.c        combine three portable graymaps into one portable pixmap
  254.     spctoppm.c        convert Atari compressed Spectrum to portable pixmap
  255.     sputoppm.c        convert Atari uncompressed Spectrum to portable pixmap
  256.     tgatoppm.c        convert TrueVision Targa file to portable pixmap
  257.     ximtoppm.c        convert Xim to portable pixmap
  258.     xpmtoppm.c        convert XPM format to portable pixmap
  259.     yuvtoppm.c        convert Abekas YUV format to portable pixmap
  260.  
  261.     ppmtogif.c        convert portable pixmap to GIF
  262.     ppmtoicr.c        convert portable pixmap to NCSA ICR graphics
  263.     ppmtoilbm.c        convert portable pixmap to IFF ILBM
  264.     ppmtopcx.c        convert portable pixmap to PC Paintbrush format
  265.     ppmtopgm.c        convert portable pixmap to portable graymap
  266.     ppmtopi1.c        convert portable pixmap to Atari Degas .pi1
  267.     ppmtopict.c        convert portable pixmap to Macintosh PICT
  268.     ppmtopj.c        convert portable pixmap to HP PaintJet file
  269.     ppmtopuzz.c        convert portable pixmap to X11 "puzzle" file
  270.     ppmtorgb3.c        separate a portable pixmap into three portable graymaps
  271.     ppmtosixel.c    convert portable pixmap to DEC sixel format
  272.     ppmtotga.c        convert portable pixmap to TrueVision Targa file
  273.     ppmtouil.c        convert portable pixmap to Motif UIL icon file
  274.     ppmtoxpm.c        convert portable pixmap to XPM format
  275.     ppmtoyuv.c        convert portable pixmap to Abekas YUV format
  276.  
  277.     ppmdither.c        ordered dither for color images
  278.     ppmhist.c        print a histogram of a portable pixmap
  279.     ppmpat.c        create a pretty pixmap
  280.     ppmquant.c        quantize colors down to a specified number
  281.     ppmquantall        script to run ppmquant on a set of pixmaps
  282.     ppmrelief.c        run a Laplacian Relief filter on a portable pixmap
  283.  
  284.     libppm[1-5].c    a few utility routines
  285.     ppmmerge.c        merge wrapper routine
  286.     ppm.h        header file for libppm
  287.     ppmcmap.h        header file for colormap routines in libppm
  288.     ppmdraw.h        header file for simple drawing routines in libppm
  289.     libppm.h        internal header file for libppm
  290.     tga.h        definitions for TrueVision Targa files
  291.     xim.h        definitions for Xim files
  292.     *.1            manual entries for all of the tools
  293.     ppm.5        manual entry for the ppm format
  294.     libppm.3        manual entry for the ppm library
  295.  
  296. Files in pnm.shar?:
  297.  
  298.     Makefile        guess
  299.     Imakefile        for X11-type installations
  300.  
  301.     anytopnm        script to attempt to convert any format to P?M
  302.     rasttopnm.c        convert Sun raster file to portable anymap
  303.     tifftopnm.c        convert TIFF file to portable anymap
  304.     xwdtopnm.c        convert X10 or X11 window dump to portable anymap
  305.  
  306.     pnmtops.c        convert portable anymap to PostScript
  307.     pnmtorast.c        convert portable anymap to Sun raster file
  308.     pnmtotiff.c        convert portable anymap to TIFF file
  309.     pnmtoxwd.c        convert portable anymap to X11 window dump
  310.  
  311.     pnmarith.c        perform arithmetic on two portable anymaps
  312.     pnmcat.c        concatenate portable anymaps
  313.     pnmconvol.c        general MxN convolution on a portable anymap
  314.     pnmcrop.c        crop all like-colored borders off a portable anymap
  315.     pnmcut.c        select a rectangular region from a portable anymap
  316.     pnmdepth.c        change the maxval in a portable anymap
  317.     pnmenlarge.c    enlarge a portable anymap N times
  318.     pnmfile.c        describe a portable anymap
  319.     pnmflip.c        perform one or more flip operations on a portable anymap
  320.     pnmgamma.c        perform gamma correction on a portable anymap
  321.     pnmindex        script to build a visual index of a bunch of anymaps
  322.     pnminvert.c        invert a portable anymap
  323.     pnmmargin        script to add a margin to a portable anymap
  324.     pnmnoraw.c        force a portable anymap into ASCII format
  325.     pnmpaste.c        paste a rectangle into a portable anymap
  326.     pnmrotate.c        rotate a portable anymap
  327.     pnmscale.c        scale a portable anymap
  328.     pnmshear.c        shear a portable anymap
  329.     pnmsmooth        script that uses pnmconvol to smooth a anymap
  330.     pnmtile.c        replicate a portable anymap into a specified size
  331.  
  332.     libpnm[1-4].c    a few utility routines
  333.     pnmmerge.c        merge wrapper routine
  334.     pnm.h        header file for libpnm
  335.     rast.h        definitions for Sun raster files
  336.     x10wd.h        definitions for X10 window dumps
  337.     x11wd.h        definitions for X11 window dumps
  338.     *.1            manual entries for all of the tools
  339.     pnm.5        manual entry for the pnm format
  340.     libpnm.3        manual entry for the pnm library
  341.